Authenticate User using Tokens

Generates an access authentication token for a given user without their password, using an administrative token to authorize login to the application instead.

Method

/API2/auth/authenticateUserByToken

  • API Section: /API2/auth
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Domain Admin

Method Signature

Input Parameters

Name

userTokenCredentials

Object Type

Description

The user credentials for authentication by token.

Output Response

Successful Result Code

200

Response Type

string

Description of Response Type

The response is the security token as a base64 string. It is usually stored in a cookie.

Notes

The security token is an authentication token that needs to be first generated by an administrative user with full credentials first.When saved as a cookie in a web browser, it can then be used to auto-login the user into the application.

Examples